//////////////////////////////////////////////////////////////////////////////
// Copyright � 2007, Daniel �nnerby
//
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
//    * Redistributions of source code must retain the above copyright notice,
//      this list of conditions and the following disclaimer.
//
//    * Redistributions in binary form must reproduce the above copyright
//      notice, this list of conditions and the following disclaimer in the
//      documentation and/or other materials provided with the distribution.
//
//    * Neither the name of the author nor the names of other contributors may
//      be used to endorse or promote products derived from this software
//      without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
//
//////////////////////////////////////////////////////////////////////////////
#pragma once

#include <core/config.h>
#include <core/filestreams/IFileStream.h>
#include <core/audio/IBuffer.h>

//////////////////////////////////////////////////////////////////////////////
namespace musik { namespace core { namespace audio {
//////////////////////////////////////////////////////////////////////////////

class  IDecoder{

    public:

        //////////////////////////////////////////
        ///\brief
        ///Destroy the object
        ///
        ///The Destroy method is used so that it's guaranteed that the object is
        ///destroyed inside the right DLL/exe
        //////////////////////////////////////////
        virtual void    Destroy() = 0;

        //////////////////////////////////////////
        ///\brief
        ///Get the length of the track in seconds
        //////////////////////////////////////////
        //virtual double Length() = 0;

        //////////////////////////////////////////
        ///\brief
        ///Set the position in the source (in seconds)
        ///
        ///\returns
        ///The actual position set
        //////////////////////////////////////////
        virtual double SetPosition(double seconds,double totalLength) = 0;

        //////////////////////////////////////////
        ///\brief
        ///Fill the next buffer
        ///
        ///\returns
        ///false is there is nothing left
        //////////////////////////////////////////
        virtual bool GetBuffer(IBuffer *buffer) = 0; // return false to signal that we are done decoding.

        //////////////////////////////////////////
        ///\brief
        ///Open the stream
        ///
        ///\param fileStream
        ///pointer to the filestream object.
        ///
        ///\returns
        ///True if successfully opened
        //////////////////////////////////////////
        virtual bool Open(musik::core::filestreams::IFileStream *fileStream) = 0;

};

//////////////////////////////////////////////////////////////////////////////
}}} // NS
//////////////////////////////////////////////////////////////////////////////
